/*
 * Copyright 2011 Mark Davidson.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.dctmcommons;

/**
 * Simple POJO used to hold object information. It is used by
 * {@link IObjectHelper}'s walk() method.
 * @author Mark Davidson
 */
public interface ICoreObjectInfo {

	/**
	 * Gets the object type.
	 * @return The object type
	 */
	public String getObjectType();
	
	/**
	 * Gets the object name.
	 * @return The object name
	 */
	public String getObjectName();
	
	/**
	 * Gets the object id.
	 * @return The object id
	 */
	public String getObjectId();
	
	/**
	 * Gets the object path.
	 * @return The object path
	 */
	public String getObjectPath();
	
	/**
	 * Gets the folder path.
	 * @return The folder path
	 */
	public String getFolderPath();
	
	/**
	 * Gets the ACL name.
	 * @return The ACL name
	 */
	public String getAclName();
	
	/**
	 * Gets the content size.
	 * @return The content size
	 */
	public int getContentSize();
	
	/**
	 * Gets the content type.
	 * @return The content type
	 */
	public String getContentType();
	
	/**
	 * Gets the link count.
	 * @return The link count
	 */
	public int getLinkCount();
	
	/**
	 * Whether it's a virtual document.
	 * @return Whether it's a virtual document
	 */
	public boolean isVirtualDoc();
}
